ShippingOptions API

Using the ShippingOptions API, a merchant will be able to receive the shipping services that are available when looking at delivering to a particular location. The services that appear depend on the origin location of the parcel, delivery location and shipping services that the merchant has available on their account. The cost for each of the available services is also returned back to the merchant.

Uses of the ShippingOptions API

Show all of the services and costs available to a customer

As a customer purchases their goods on a merchant's website, they enter their delivery address details into the website. From their provided address, the merchant's website will return the shipping services that are available (i.e. express service, standard service etc) and the cost per service. The customer can then select which service they want to use. From selecting the service, additional add-on services will appear (such as signature required delivery). After choosing their desired shipping service, the customer will then proceed to the payment screen to complete their purchase.

Show limited services and costs available to a customer

As in the prior use case, a customer purchases their goods on a merchant's website, they enter their delivery address details into the website. From their provided address, the merchant's website will only pass through a limited selection of the shipping services that are available (i.e. only a express service, not a standard service etc) and the cost of this service. The customer can then select from this limited range, which service they want to use. From selecting the service, additional add-on services will appear (such as signature required delivery). After choosing their desired shipping service, the customer will then proceed to the payment screen to complete their purchase.

Show the services available to a customer with a defined price (including any internal handling fees)

As in the first use case, a customer purchases their goods on a merchant's website, they enter their delivery address details into the website. From their provided address, the merchant's website will return the shipping services that are available (i.e. express service, standard service etc) and a defined cost. (This cost for each service is determined by the merchant and may include the internal handling fees). The customer can then select which service they want to use. From selecting the service, additional add-on services will appear (such as signature required delivery). After choosing their desired shipping service, the customer will then proceed to the payment screen to complete their purchase.